Deprecate and make Fonts API non-functional. #52485

hellofromtonya · 2023-07-10T19:17:39Z

Closes 51819.

What?

Creates a BC Layer in the new Font Face.

Deprecates all of the Fonts API's public-facing files, functions, classes, and methods.

Makes the Fonts API non-functional, i.e. as Font Face replaces it.

Why?

Font Face replaces Fonts API.

For sites using the Fonts API, this PR:

Avoids those sites experiencing a fatal parsing error.
Makes the Fonts API non-functional to avoid conflicts with the new font management approach.

How?

Copies all of the Fonts API's files into a new fonts/bc-layer directory.
Removes all private methods.
Removes all functionality from remaining functions and methods.
Deprecates all of the files, classes, functions, and methods.
Loads the files into memory (to avoid fatal parsing errors on sites using it).

Testing Instructions

Set up

Enable the loading of the Font Face files:
a. Open lib/load.php.
b. Scroll down to where the Font Face files are loaded.
c. Add true || in the if:

if ( true || class_exists( 'WP_Fonts_Library' ) || class_exists( 'WP_Fonts_Library_Controller' ) ) {

Plugin using the Fonts API:

Install and activate this test plugin.
Comment out these 3 lines of code in the webfonts.php file:

                 if ( ! function_exists( 'wp_register_font_provider' ) || ! function_exists( 'wp_register_fonts' ) ) {
                        return;
                }

Reproduce the fatal error

Before applying the changes from this PR (or comment out the BC Layer files loading in lib/load.php, refresh the admin page on your test site.

Expected: Fatal error such as:

Fatal error: Uncaught Error: Call to undefined function wp_register_font_provider() in ../wp-content/plugins/webfonts-jetpack-test/webfonts.php:79

the path to the webfonts.php will be different in your test site.

This fatal error happens because the tester plugin is using the Fonts API but it is not loaded into memory.

Test this PR

Apply the changes from this PR to your local testing site.
Refresh the admin page.
Expected: No fatal error. There will be deprecation notices as the tester plugin is using the Fonts API (which is now deprecated).
Check that none of the Google Fonts from the tester plugin are in the font pickers:
a. Go to Site Editor > Styles > Typography > Headings.
b. Select "FONT".
Expected: Google Fonts such as Arvo, Merriweather, Open Sans, etc. are not in the list. Rather, only the theme's fonts in the list.

Using TT3, the FONT picker should contain:

Default
DM Sans
IBM Plex Mono
Inter
System Font
Source Serif Pro

Note: To see all of the Google Fonts the tester plugin registers, remove the true so that the Font Face libs are not loaded.

With Font Face, the Fonts API is no longer needed. However for sites using Fonts API, the public facing functions, classes, and methods still need to be available in memory to avoid fatal errors. This commit: 1. Adds a bc-layer into the Font Face. 2. Copies each of the Fonts API files into it. 3. Deprecates each file and public function, class, and method. 4. Makes each function and method non-functional.

anton-vlasenko · 2023-07-13T23:25:52Z

Test Report

PR tested: #52485

Environment

WordPress: 6.3-beta3-56130-src
PHP: 8.0.27
Server: Apache/2.4.55 (Unix) PHP/8.0.27
Database: mysqli (Server: 5.7.38 / Client: mysqlnd 8.0.27)
Browser: Safari 16.5 (macOS)
Theme: Twenty Twenty-Three 1.1
MU-Plugins: None activated
Plugins:
- Fonts API Test Plugin 1.0.0-ironprogrammer
- Gutenberg 16.2.0-rc.1

Steps to Test

Follow the steps listed in the PR's description above.

Expected Results

Fatal error

Uncaught Error: Class 'WP_Fonts_Resolver' not found

occurs before applying the changes from this PR.
2. The font picker should contain the expected fonts.

Actual Results

❌ Fatal error Uncaught Error: Class 'WP_Fonts_Resolver' not found doesn't occur whether using the trunk branch or commenting out the BC layer files loading in load.php.
✅ The font picker contains the expected fonts.

Supplemental Artifacts

anton-vlasenko

The code LGTM.
However, I'm not sure why the fatal error doesn't occur when the BC layer files are not loaded. Please see my test report here: #52485 (comment).

aristath

Code LGTM 👍

lib/experimental/fonts/bc-layer/class-gutenberg-fonts-api-bc-layer.php

hellofromtonya · 2023-07-18T19:22:03Z

The code LGTM.
However, I'm not sure why the fatal error doesn't occur when the BC layer files are not loaded. Please see my test report here: #52485 (comment).

Oh silly me 🤦‍♀️ Thanks @anton-vlasenko for flagging this. I missed a step in the Set up process and the fatal error is a different one.

I've updated the testing instructions. The tester plugin already guards against the functions not existing. By commenting out those lines of code, a fatal error will happen when it attempts to invoke wp_register_font_provider() when it does not exist in memory.

anton-vlasenko · 2023-07-19T12:11:43Z

I've updated the testing instructions. The tester plugin already guards against the functions not existing. By commenting out those lines of code, a fatal error will happen when it attempts to invoke wp_register_font_provider() when it does not exist in memory.

Thank you, @hellofromtonya. I'm able to reproduce the fatal error now.

anton-vlasenko

LGTM ✅.

hellofromtonya · 2023-07-19T14:03:10Z

Thank you @aristath and @anton-vlasenko 🎉 Merging now.

hellofromtonya · 2023-09-06T15:14:10Z

Removed Needs PHP backport label as this PR will not be backported to Core. The Fonts API is deprecated within the plugin.

hellofromtonya self-assigned this Jul 10, 2023

hellofromtonya added [Feature] Fonts API [Feature] Typography Font and typography-related issues and PRs labels Jul 10, 2023

hellofromtonya force-pushed the try/deprecate-fonts-api branch from 3f9804b to 7d6f907 Compare July 11, 2023 19:40

WordPress deleted a comment from github-actions bot Jul 11, 2023

hellofromtonya added 2 commits July 11, 2023 14:42

Load the BC Layer

71f09ac

hellofromtonya force-pushed the try/deprecate-fonts-api branch from 7d6f907 to 71f09ac Compare July 11, 2023 19:42

hellofromtonya changed the title ~~Deprecate Fonts API. Make non-functional.~~ Deprecate and make Fonts API non-functional. Jul 11, 2023

Do not load fonts-api.php file

b994215

WordPress deleted a comment from github-actions bot Jul 11, 2023

hellofromtonya marked this pull request as ready for review July 11, 2023 20:55

hellofromtonya requested a review from spacedmonkey as a code owner July 11, 2023 20:55

hellofromtonya requested review from anton-vlasenko and aristath and removed request for spacedmonkey July 11, 2023 20:55

anton-vlasenko reviewed Jul 13, 2023

View reviewed changes

aristath approved these changes Jul 14, 2023

View reviewed changes

lib/experimental/fonts/bc-layer/class-gutenberg-fonts-api-bc-layer.php Show resolved Hide resolved

anton-vlasenko approved these changes Jul 19, 2023

View reviewed changes

hellofromtonya merged commit 36f2288 into trunk Jul 19, 2023

hellofromtonya deleted the try/deprecate-fonts-api branch July 19, 2023 14:06

github-actions bot added this to the Gutenberg 16.3 milestone Jul 19, 2023

mburridge added the [Type] Bug An existing feature does not function as intended label Jul 19, 2023

mikachan mentioned this pull request Sep 5, 2023

Plugin: Synchronize PHP changes for WordPress 6.4 release #54177

Closed

86 tasks

mikachan added the Needs PHP backport Needs PHP backport to Core label Sep 5, 2023

hellofromtonya removed the Needs PHP backport Needs PHP backport to Core label Sep 6, 2023

iandunn mentioned this pull request Oct 3, 2023

Custom fonts are not loaded correctly in block themes WordPress/wordcamp.org#1075

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate and make Fonts API non-functional. #52485

Deprecate and make Fonts API non-functional. #52485

hellofromtonya commented Jul 10, 2023 •

edited

Loading

anton-vlasenko commented Jul 13, 2023 •

edited

Loading

anton-vlasenko left a comment •

edited

Loading

aristath left a comment

hellofromtonya commented Jul 18, 2023

anton-vlasenko commented Jul 19, 2023

anton-vlasenko left a comment

hellofromtonya commented Jul 19, 2023

hellofromtonya commented Sep 6, 2023

Deprecate and make Fonts API non-functional. #52485

Deprecate and make Fonts API non-functional. #52485

Conversation

hellofromtonya commented Jul 10, 2023 • edited Loading

What?

Why?

How?

Testing Instructions

Set up

Reproduce the fatal error

Test this PR

anton-vlasenko commented Jul 13, 2023 • edited Loading

Test Report

Environment

Steps to Test

Expected Results

Actual Results

Supplemental Artifacts

anton-vlasenko left a comment • edited Loading

Choose a reason for hiding this comment

aristath left a comment

Choose a reason for hiding this comment

hellofromtonya commented Jul 18, 2023

anton-vlasenko commented Jul 19, 2023

anton-vlasenko left a comment

Choose a reason for hiding this comment

hellofromtonya commented Jul 19, 2023

hellofromtonya commented Sep 6, 2023

hellofromtonya commented Jul 10, 2023 •

edited

Loading

anton-vlasenko commented Jul 13, 2023 •

edited

Loading

anton-vlasenko left a comment •

edited

Loading